/**
 * Copyright @2012 中国电信甘肃万维公司 All rights reserved.
 * 中国电信甘肃万维公司 专有/保密源代码,未经许可禁止任何人通过任何* 渠道使用、修改源代码.
 * 日期 2012-7-27 下午05:49:27
 */
package com.oa.cs.agreement.pojo.sys;

import java.io.Serializable;

import com.oa.cs.agreement.pojo.IRequestObject;
import com.oa.cs.agreement.pojo.IResponseObject;

/**
 * <p>
 * Login描述:登录协议
 * </p>
 * @company 中国电信甘肃万维公司 
 *
 * @project nma-s-agreement
 *
 * @version V2.0.0
 *
 * @author 郭磊(产品部)
 *
 * @date 2012-7-27 下午05:49:27	
 *
 * @class com.oa.cs.agreement.pojo.sys.Login
 *
 */
public interface Login extends Sys 
{
	/** 
	 *  SERVICE :  TODO 服务目标地址	SERVICE = ""
	 */
	public static final String SERVICE = "/esb/login_esb_service";
	
	public interface Request extends IRequestObject
	{
		/** 
		 *  LOGIN_NAME :  TODO 登录名	LOGIN_NAME = "LOGIN_NAME"  类型：String
		 */
		public static final String LOGIN_NAME = "LOGIN_NAME";
		
		/** 
		 *  LOGIN_PWD :  TODO 登录密码 	LOGIN_PWD = "LOGIN_PWD"  类型：String
		 */
		public static final String LOGIN_PWD = "LOGIN_PWD";
		
		/** 
		 *  PROVINCE :  TODO 用户省份 	PROVINCE = "PROVINCE"  类型：String
		 */
		public static final String PROVINCE = "PROVINCE";
		
		/** 
		 *  CLIENT_TIME :  TODO 客户端时间 	CLIENT_TIME = "CLIENT_TIME"  类型：String
		 */
		public static final String CLIENT_TIME = "CLIENT_TIME";
		
		/** 
		 *  LOGIN_IP :  TODO 来路IP地址	LOGIN_IP = "LOGIN_IP"  类型：String
		 */
		public static final String LOGIN_IP = "LOGIN_IP";
		
		/** 
		 *  HAND_RRSOLUTION :  TODO 手机分辨率	HAND_RRSOLUTION = "HAND_RRSOLUTION"  类型：String , 格式例子：800*480
		 */
		public static final String HAND_RRSOLUTION = "HAND_RRSOLUTION";
		
	}

	
	public interface Response extends IResponseObject
	{
		/** 
		 *  SID :  TODO 本次请求的会话ID	SID = "SID" 类型：String
		 */
		public static final String SID = "SID";

		/** 
		 *  USER_ID :  TODO 本次请求的会话用户ID	USER_ID = "USER_ID" 类型：String
		 */
		public static final String USER_ID = "USER_ID";
		
		/** 
		 *  LOGIN_SUCCESS :  TODO 本次登录是否成功	LOGIN_SUCCESS = "LOGIN_SUCCESS" 类型 ： 枚举(LOGIN_SUCCESS_ENUM)
		 */		
		public static final String LOGIN_SUCCESS = "LOGIN_SUCCESS";
		
		
		/**
		 *  LOGIN_MSG :  TODO 本次登录返回的提示消息	LOGIN_MSG = "LOGIN_MSG" 类型:String
		 */
		public static final String LOGIN_MSG = "LOGIN_MSG";
		
		/**
		 *  NEW_VERSION :  TODO 后台最新的客户端版本	NEW_VERSION = "NEW_VERSION" 类型:String 格式：x.x.x，例如:2.0.0
		 */
		public static final String NEW_VERSION = "NEW_VERSION";
		
		/**
		 *  IS_ENFORCE :  TODO 是否让客户端进行强制升级	IS_ENFORCE = "IS_ENFORCE" 类型:IS_ENFORCE_ENUM
		 */
		public static final String IS_ENFORCE = "IS_ENFORCE";
		
		/** 是否强制升级客户端枚举 */
		public enum IS_ENFORCE_ENUM implements Serializable
		{
			/** 进行升级	 	YES = 0	**/
			YES((byte)0),
			/** 不进行进行升级	NO = 1 **/
			NO((byte)1);
			
			byte value = 0;
			
			IS_ENFORCE_ENUM(byte value)
			{
				this.value = value;
			}
			
			public byte getValue()
			{
				return this.value;
			}
		}
		
		/**
		 *  UPDATE_MSG :  TODO 提示升级的消息	UPDATE_MSG = "UPDATE_MSG" 类型:String
		 */
		public static final String UPDATE_MSG = "UPDATE_MSG";
		
		/**
		 *  MENUS :  TODO 菜单	MENUS = "MENUS" 类型:Map<String(菜单ID),Map<String(菜单属性),String(菜单属性值)>> 
		 */
		public static final String MENUS = "MENUS";
		
		/**
		 *  DOWNLOAD_ADDRESS :  TODO 新版本下载地址	DOWNLOAD_ADDRESS = "DOWNLOAD_ADDRESS"
		 */
		public static final String DOWNLOAD_ADDRESS = "DOWNLOAD_ADDRESS";
		
		/** photo_download_address 通讯录头像下载地址		PHOTO_DOWNLOAD_ADDRESS = "pda" */
		public static final String PHOTO_DOWNLOAD_ADDRESS = "pda";
		/** photo_upload_address 通讯录头像上传地址		PHOTO_UPLOAD_ADDRESS = "pua" */
		public static final String PHOTO_UPLOAD_ADDRESS = "pua";
		
		/** attachment_download_address 附件下载地址		ATTACHMENT_DOWNLOAD_ADDRESS = "ada" */
		public static final String ATTACHMENT_DOWNLOAD_ADDRESS = "ada";
		/** attachment_upload_address 附件上传地址		ATTACHMENT_UPLOAD_ADDRESS = "aua" */
		public static final String ATTACHMENT_UPLOAD_ADDRESS = "aua";
		/** ATTACHMENT_DELETE_ADDRESS 附件删除地址		ATTACHMENT_DELETE_ADDRESS = "att_da" */
		public static final String ATTACHMENT_DELETE_ADDRESS = "att_da";
		
		
		/** document_download_address 文档模块下载地址		DOCUMENT_DOWNLOAD_ADDRESS = "dda" */
		public static final String DOCUMENT_DOWNLOAD_ADDRESS = "dda";
		/** document_upload_address 文档模块上传地址		DOCUMENT_UPLOAD_ADDRESS = "dua" */
		public static final String DOCUMENT_UPLOAD_ADDRESS = "dua";

		/** DOC_CONTENT_ADDRESS 公文正文下载地址		DOC_CONTENT_ADDRESS = "dca" */
		public static final String DOC_CONTENT_ADDRESS = "dca";
		
		/** DOC_CONTENT_DOWNLOAD_ADDRESS 公文正文下载地址		DOC_CONTENT_DOWNLOAD_ADDRESS = "dbda" */
		public static final String DOC_CONTENT_DOWNLOAD_ADDRESS = "dcda";
		
		/** UN_READ_ADDRESS 未读条数地址		UN_READ_ADDRESS = "ura" */
		public static final String UN_READ_ADDRESS = "ura";
		
		/**
		 *  OA_URL :  TODO PC端的域名	OA_URL = "OA_URL" 类型:String
		 */
		public static final String OA_URL = "OA_URL";
		
		/**
		 *  USER_NAME :  TODO 用户名 	USER_NAME = "user_name" 类型:String
		 */
		public static final String USER_NAME = "user_name";

		/**
		 *  USER_PHONE :  TODO 用户名 	USER_PHONE = "user_phone" 类型:String
		 */
		public static final String USER_PHONE = "user_phone";
		
		/**
		 *  FCK_IMAGE_URL :  TODO fck图片存储路径	FCK_IMAGE_URL = "fiu" 类型:String
		 */
		public static final String FCK_IMAGE_URL = "fiu";
		
		/*
		 *  MAX_UPLOAD_SIZE :  TODO 客户端上传文件大小限制		MAX_UPLOAD_SIZE = "mus" 类型:String
		 */
		public static final String MAX_UPLOAD_SIZE = "mus";
		
		/**
		 *  ORG_FULL_NAME :  TODO 单位全名	ORG_FULL_NAME = "ORG_FULL_NAME" 类型:String
		 */
		public static final String ORG_FULL_NAME = "ORG_FULL_NAME";
		
		/**
		 *  FULL_ORG_NAME :  TODO 省份标示	FULL_ORG_NAME = "FULL_ORG_NAME" 类型:String
		 */
		public static final String FULL_ORG_NAME = "FULL_ORG_NAME";
		
		/**
		 *  USER_PHONE :  TODO 单位id 	ORG_ID = "ORG_ID" 类型:String
		 */
		public static final String ORG_ID = "ORG_ID";
		
		/**
		 *  USER_PHONE :  TODO 默认单位图片地址，oa_url+org_logo  ,如果此值为空，则根据orgId去取
		 *   	DEFAULT_ORG_LOGO = "DEFAULT_ORG_LOGO" 类型:String
		 */
		public static final String DEFAULT_ORG_LOGO = "DEFAULT_ORG_LOGO";
		
		/**
		 *  USER_PHONE :  TODO 默认单位图片下载地址   如 ORG_LOGO_DOWNLAD+ORG_ID
		 *   	ORG_LOGO_DOWNLAD = "ORG_LOGO_DOWNLAD" 类型:String
		 */
		public static final String ORG_LOGO_DOWNLAD = "ORG_LOGO_DOWNLAD";
		
		/**
		 *  USER_PHONE :  TODO 默认协同图片下载地址   如COLLABORATE_IMG
		 */
		public static final String COLLABORATE_IMG = "COLLABORATE_IMG";
		
		/**
		 *  SESSION_ID :  TODO 会话ID   如SESSION_ID
		 */
		public static final String SESSION_ID = "SESSION_ID";
		
		/**
		 *  SMS_RIGHT :  TODO 发送短信权限   1---有权限   0 ----没有权限
		 */
		public static final String SMS_RIGHT = "SMS_RIGHT";
		
	}
}
